Skip to content

Conversation

@DaanHoogland
Copy link
Contributor

Description

This PR

Fixes: #3685 partially as unlinking an account has no good functional definition (yet)
Fixes: #11474 by removing a long time deprecated parameter

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • Build/CI
  • Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

@DaanHoogland
Copy link
Contributor Author

@blueorangutan package

@blueorangutan
Copy link

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

@codecov
Copy link

codecov bot commented Nov 3, 2025

Codecov Report

❌ Patch coverage is 6.06061% with 31 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.56%. Comparing base (ac3b180) to head (20b5413).
⚠️ Report is 36 commits behind head on main.

Files with missing lines Patch % Lines
...loudstack/api/command/UnlinkDomainFromLdapCmd.java 0.00% 16 Missing ⚠️
...va/org/apache/cloudstack/ldap/LdapManagerImpl.java 0.00% 13 Missing ⚠️
...he/cloudstack/api/command/LinkDomainToLdapCmd.java 33.33% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##               main   #11962   +/-   ##
=========================================
  Coverage     17.56%   17.56%           
- Complexity    15534    15549   +15     
=========================================
  Files          5911     5914    +3     
  Lines        529359   529455   +96     
  Branches      64655    64679   +24     
=========================================
+ Hits          92957    93002   +45     
- Misses       425945   425991   +46     
- Partials      10457    10462    +5     
Flag Coverage Δ
uitests 3.58% <ø> (-0.01%) ⬇️
unittests 18.63% <6.06%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds functionality to unlink a CloudStack domain from LDAP, complementing the existing linkDomainToLdap functionality. The changes also include refactoring improvements to clean up the LinkDomainToLdapCmd by removing deprecated parameters and improving logging.

Key Changes

  • Added new unlinkDomainFromLdap API command to remove domain-to-LDAP linkages
  • Removed deprecated name parameter and improved the LinkDomainToLdapCmd implementation
  • Applied minor code modernization (diamond operator, parametrized logging)

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
UnlinkDomainFromLdapCmd.java New API command for unlinking domains from LDAP
LdapManager.java Added interface method for unlinking and removed trailing semicolon from enum
LdapManagerImpl.java Implemented unlinkDomainFromLdap method and applied diamond operator refactoring
LinkDomainToLdapCmd.java Removed deprecated name parameter, made ldapDomain required, and improved logging
pom.xml Added explicit cloud-api dependency
Comments suppressed due to low confidence (1)

plugins/user-authenticators/ldap/src/main/java/org/apache/cloudstack/ldap/LdapManagerImpl.java:308

  • The new UnlinkDomainFromLdapCmd class is not registered in the getCommands() list, which means it won't be available as an API command. Add cmdList.add(UnlinkDomainFromLdapCmd.class); before the return statement.
        final List<Class<?>> cmdList = new ArrayList<>();
        cmdList.add(LdapUserSearchCmd.class);
        cmdList.add(LdapListUsersCmd.class);
        cmdList.add(LdapAddConfigurationCmd.class);
        cmdList.add(LdapDeleteConfigurationCmd.class);
        cmdList.add(LdapListConfigurationCmd.class);
        cmdList.add(LdapCreateAccountCmd.class);
        cmdList.add(LdapImportUsersCmd.class);
        cmdList.add(LDAPConfigCmd.class);
        cmdList.add(LDAPRemoveCmd.class);
        cmdList.add(LinkDomainToLdapCmd.class);
        cmdList.add(LinkAccountToLdapCmd.class);
        return cmdList;

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@shwstppr shwstppr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some comments, idea looks good. Will need testing

Copy link
Member

@vishesh92 vishesh92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good to me. Just one change is required.

@Override
public List<Class<?>> getCommands() {
final List<Class<?>> cmdList = new ArrayList<Class<?>>();
final List<Class<?>> cmdList = new ArrayList<>();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to add the unlinkDomainFromLdap command here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, tnx

Copy link
Contributor

@kiranchavala kiranchavala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DaanHoogland

(localcloud) 🐱 > link domaintoldap domainid=0735d7e8-5dcc-4b48-8049-81c69d8830d3 type=GROUP accounttype=2 ldapdomain=cn=qa-team,ou=Telco-Bng,dc=example,dc=in name=qa admin=admin
{
  "LinkDomainToLdap": {
    "accounttype": 2,
    "domainid": "0735d7e8-5dcc-4b48-8049-81c69d8830d3",
    "ldapdomain": "cn=qa-team,ou=Telco-Bng,dc=example,dc=in",
    "name": "cn=qa-team,ou=Telco-Bng,dc=example,dc=in",
    "type": "GROUP"
  }
}

mysql> select * from ldap_configuration;
+----+-----------+------+-----------+--------------------------------------+
| id | hostname  | port | domain_id | uuid                                 |
+----+-----------+------+-----------+--------------------------------------+
|  2 | localhost |  389 |         2 | e07853d9-73dc-4486-9acf-66937c8123a5 |
+----+-----------+------+-----------+--------------------------------------+
1 row in set (0.00 sec)

mysql> select * from ldap_trust_map;
+----+-----------+-------+------------------------------------------+--------------+------------+
| id | domain_id | type  | name                                     | account_type | account_id |
+----+-----------+-------+------------------------------------------+--------------+------------+
|  1 |         2 | GROUP | cn=qa-team,ou=Telco-Bng,dc=example,dc=in |            2 |          0 |
+----+-----------+-------+------------------------------------------+--------------+------------+
1 row in set (0.00 sec)

Getting the following response from the api , but the entry is deleted from the database

(localcloud) 🐱 > unlink domainfromldap domainid=0735d7e8-5dcc-4b48-8049-81c69d8830d3
🙈 Error: failed to decode response

mysql> select * from ldap_trust_map;
Empty set (0.00 sec)

Also the UI progress doesn't stop when a user tried to link domain to ldap

Screenshot 2025-11-05 at 5 22 05 PM

@DaanHoogland
Copy link
Contributor Author

@kiranchavala , those issues are fixed, however there are some polish issues remaining, like the condition to enable link or unlink are not available in the UI atm and I need to decide/discuss how to address these.

@apache apache deleted a comment from blueorangutan Nov 5, 2025
@apache apache deleted a comment from blueorangutan Nov 5, 2025
@apache apache deleted a comment from blueorangutan Nov 5, 2025
@apache apache deleted a comment from blueorangutan Nov 5, 2025
@apache apache deleted a comment from blueorangutan Nov 5, 2025
@apache apache deleted a comment from blueorangutan Nov 5, 2025
@apache apache deleted a comment from blueorangutan Nov 5, 2025
@blueorangutan
Copy link

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 15643

@rajujith
Copy link

@DaanHoogland, there is a similar use case with accounts where there are no UI options https://cloudstack.apache.org/api/apidocs-4.20/apis/linkAccountToLdap.html. Should this also be considered in this PR?

@kiranchavala
Copy link
Contributor

@DaanHoogland, there is a similar use case with accounts where there are no UI options https://cloudstack.apache.org/api/apidocs-4.20/apis/linkAccountToLdap.html. Should this also be considered in this PR?

Yes @rajujith @DaanHoogland

The improvement issue is already present

#11473

@DaanHoogland
Copy link
Contributor Author

@DaanHoogland, there is a similar use case with accounts where there are no UI options https://cloudstack.apache.org/api/apidocs-4.20/apis/linkAccountToLdap.html. Should this also be considered in this PR?

Yes @rajujith @DaanHoogland

The improvement issue is already present

#11473

guys (@rajujith @kiranchavala), I don’t want to add and create a big beautiful PR. I’d rather implement smaller well tested changes, if you don’t mind. We need to have a backend change in DomainResponse as well to be able to decide whether to show the link or the unlink button. I am sure we will find more issues while working on this.

Copy link
Contributor

@Pearl1594 Pearl1594 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linking and unlinking of domain to ldap works fine, however, as an improvement to this it would be nice to selectively show and hide the link/unlink buttons based on whether the domain is linked to an LDAP or not. But that could happen on a separate PR> Also, ldapdomain requires translation
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Api/UI: Update API docs or remove the name or ldapdomain parameter no way to unlink account/domain from ldap

7 participants